/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * <http://www.mongodb.com/licensing/server-side-public-license>.
 */
package org.graylog2.indexer.results;

import org.graylog2.plugin.Message;

import java.util.List;
import java.util.Map;

public interface ResultMessageFactory {
    /**
     * Returns a new {@link ResultMessage} for the given fields.
     *
     * @param id      the ID field value
     * @param index   the index name field
     * @param message the map of message fields
     * @return the new result message
     */
    ResultMessage parseFromSource(String id, String index, Map<String, Object> message);

    /**
     * Returns a new {@link ResultMessage} for the given fields.
     *
     * @param id        the ID field value
     * @param index     the index name field
     * @param message   the map of message fields
     * @param highlight the map of fields to highlight
     * @return the new result message
     */
    ResultMessage parseFromSource(String id, String index, Map<String, Object> message, Map<String, List<String>> highlight);

    /**
     * Creates a new {@link ResultMessage} for the given {@link Message}.
     *
     * @param message the message
     * @return the new result message
     */
    ResultMessage createFromMessage(Message message);
}
